Skip to main content
PATCH
/
tools
/
{tool_id}
Toggle Tool
curl --request PATCH \
  --url https://agent-prod.studio.lyzr.ai/v3/tools/{tool_id} \
  --header 'x-api-key: <api-key>'
{
  "message": "Tool updated successfully."
}

​
Description

Enable or disable a tool dynamically.

​
Endpoint

PATCH /v3/tools/{tool_id}

​
Authentication

API Key (x-api-key) must be included in the header.

​
Path Parameters

  • tool_id (string) - The ID of the tool to update.

​
Query Parameters

  • enabled (boolean) - Set true to enable or false to disable the tool.

​
Response

A message confirming that the tool was updated.

​
Example Request

curl -X PATCH "https://agent-prod.studio.lyzr.ai/v3/tools/tool_id?enabled=1" ^
-H "accept: application/json" ^
-H "x-api-key: sk-default-EXAMPLEKEY123"

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
tool_id
string
required

The ID of the tool to update.

Query Parameters

​
enabled
boolean
required

Set true to enable or false to disable the tool.

Response

Tool updated successfully

​
message
string
Example:

"Tool updated successfully."